feat: Support for reference tag [#153] #154
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
milesj
reviewed
Aug 4, 2024
| @@ -74,6 +76,37 @@ export default function ApiItem({ readme: Readme, route }: ApiItemProps) { | |||
| [nextItem, prevItem], | |||
| ); | |||
|
|
|||
| // Add @reference categories. | |||
| const referenceCategories: Record<string, { title: string; children: number[] }> = {}; | |||
There was a problem hiding this comment.
This data should probably be built before even making it to the react side of things.
There was a problem hiding this comment.
Fixed. Please re-review.
rash805115
changed the title
|
Hi @milesj Can you take a look when you have a chance? |
|
Hello @milesj Can you please review this when you get a chance? |
|
Can you post a screenshot of what this looks like in practice? |
|
@milesj The screenshot in PR description is taken from a real example. The new sections |
|
@milesj One last question, how can we release the changes? Is it automatically triggered? |
|
I have to manually do it. I'll get around to it later today. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds support to show
@referencetag, which is a custom tag, as discussed in #153You can use this tag as
@reference <Name> {@link <Exported class>}E.g.
It would look like,
If your IDE complains about using
@referencetag, which is a custom tag not supported in TypeDoc, then you will need to extend their schema definition by putting a newtsdoc.jsonin the root of your directory.{ "$schema": "https://developer.microsoft.com/en-us/json-schemas/tsdoc/v0/tsdoc.schema.json", "extends": ["typedoc/tsdoc.json"], "noStandardTags": false, "tagDefinitions": [ { "tagName": "@reference", "syntaxKind": "block", "allowMultiple": true } ] }